Pular para o conteúdo principal

6.2 Consultar escolas

Request

Request

query Companies {
    companies(take: 1, where: { name: { contains: "Teste" } }) {
        items {
            parentCompanyId
            name
            cnpj
            companyName
            billetType
            contractValidity
            negotiatedRate
            transferDay
            transferTax
            transferDaySecondary
            transferTaxSecondary
            legacyBilling
            interestValue
            fineValue
            hasCashback
            id
            creationDate
            active
            deleted
            documents {
                id
            }
            refId
        }
        pageInfo {
            hasNextPage
        }
        totalCount
    }
}

Params

Parâmetro	Tipo	Descrição
skip	Int	Número de registros a serem pulados no início da coleção. Utilizado para paginação.
take	Int	Número máximo de registros a serem retornados. Utilizado para paginação.
where	CompanyFilterInput	Objeto que define os critérios de filtragem para as escolas.
order	[CompanySortInput!]	Array de objetos que definem a ordem de classificação dos resultados.

Objeto CompanyFilterInput

Campo	Tipo	Descrição
active	BooleanOperationFilterInput	Filtro para o status de ativação
address	AddressFilterInput	Filtro para os dados do endereço
and	[CompanyFilterInput!]	Combina filtros usando a lógica AND
bank	BankFilterInput	Filtro para os dados do banco
billetType	NullableOfCompanyBilletTypeOperationFilterInput	Filtro para o tipo de cobrança
changes	ListFilterInputTypeOfLogHistoryFilterInput	Filtro para o histórico de alterações
cnpj	StringOperationFilterInput	Filtro para o CNPJ
companyLogo	StorageFileFilterInput	Filtro para os dados do logotipo
companyName	StringOperationFilterInput	Filtro para a razão social
contractValidity	IntOperationFilterInput	Filtro para a validade do contrato
creationDate	DateTimeOperationFilterInput	Filtro para a data de criação
deleted	BooleanOperationFilterInput	Filtro para o status de deleção
documents	ListFilterInputTypeOfStorageFileFilterInput	Filtro para os documentos
externalId	IntOperationFilterInput	Filtro para o ID externo
financialIntegrations	ListFilterInputTypeOfFinancialIntegrationFilterInput	Filtro para as integrações financeiras
fineValue	DecimalOperationFilterInput	Filtro para o valor da multa
hasCashback	BooleanOperationFilterInput	Filtro para o status de cashback
id	IntOperationFilterInput	Filtro para o ID do objeto
interestValue	DecimalOperationFilterInput	Filtro para o valor dos juros
lastUpdateDate	DateTimeOperationFilterInput	Filtro para a data da última atualização
legacyBilling	BooleanOperationFilterInput	Filtro para o status do legado de cobrança
name	StringOperationFilterInput	Filtro para o nome
negotiatedRate	DecimalOperationFilterInput	Filtro para a taxa de inadimplência negociada
or	[CompanyFilterInput!]	Combina filtros usando a lógica OR
parentCompany	CompanyFilterInput	Filtro para a empresa pai
parentCompanyId	IntOperationFilterInput	Filtro para o ID da empresa pai
paymentPlans	ListFilterInputTypeOfPaymentPlanFilterInput	Filtro para os planos de pagamento
refId	UuidOperationFilterInput	Filtro para o ID de referência
transferDay	IntOperationFilterInput	Filtro para o dia de transferência
transferDaySecondary	IntOperationFilterInput	Filtro para o dia de transferência secundária
transferTax	DecimalOperationFilterInput	Filtro para a taxa de transferência
transferTaxSecondary	DecimalOperationFilterInput	Filtro para a taxa de transferência secundária
webHooks	ListFilterInputTypeOfWebHookFilterInput	Filtro para os webhooks

Objeto CompanySortInput

Campo	Tipo	Descrição
active	SortEnumType	Critério de ordenação para o status de ativação
address	AddressSortInput	Critério de ordenação para os dados do endereço
bank	BankSortInput	Critério de ordenação para os dados do banco
billetType	SortEnumType	Critério de ordenação para o tipo de cobrança
cnpj	SortEnumType	Critério de ordenação para o CNPJ
companyLogo	StorageFileSortInput	Critério de ordenação para os dados do logotipo
companyName	SortEnumType	Critério de ordenação para a razão social
contractValidity	SortEnumType	Critério de ordenação para a validade do contrato
creationDate	SortEnumType	Critério de ordenação para a data de criação
deleted	SortEnumType	Critério de ordenação para o status de deleção
externalId	SortEnumType	Critério de ordenação para o ID externo
fineValue	SortEnumType	Critério de ordenação para o valor da multa
hasCashback	SortEnumType	Critério de ordenação para o status de cashback
id	SortEnumType	Critério de ordenação para o ID do objeto
interestValue	SortEnumType	Critério de ordenação para o valor dos juros
lastUpdateDate	SortEnumType	Critério de ordenação para a data da última atualização
legacyBilling	SortEnumType	Critério de ordenação para o status do legado de cobrança
name	SortEnumType	Critério de ordenação para o nome
negotiatedRate	SortEnumType	Critério de ordenação para a taxa de inadimplência negociada
parentCompany	CompanySortInput	Critério de ordenação para a empresa pai
parentCompanyId	SortEnumType	Critério de ordenação para o ID da empresa pai
refId	SortEnumType	Critério de ordenação para o ID de referência
transferDay	SortEnumType	Critério de ordenação para o dia de transferência
transferDaySecondary	SortEnumType	Critério de ordenação para o dia de transferência secundária
transferTax	SortEnumType	Critério de ordenação para a taxa de transferência
transferTaxSecondary	SortEnumType	Critério de ordenação para a taxa de transferência secundária

Response

Response

{
    "data": {
        "companies": {
            "items": [
                {
                    "parentCompanyId": null,
                    "name": "Nova escola teste",
                    "cnpj": "95.805.290/0001-57",
                    "companyName": null,
                    "billetType": null,
                    "contractValidity": null,
                    "negotiatedRate": null,
                    "transferDay": null,
                    "transferTax": null,
                    "transferDaySecondary": null,
                    "transferTaxSecondary": null,
                    "legacyBilling": null,
                    "interestValue": null,
                    "fineValue": null,
                    "hasCashback": null,
                    "id": 3,
                    "creationDate": "2023-08-16T15:01:39.044Z",
                    "active": true,
                    "deleted": false,
                    "documents": [],
                    "refId": "8d955cfb-2fcc-458a-aae6-20e606c8075a"
                }
            ],
            "pageInfo": {
                "hasNextPage": true
            },
            "totalCount": 15
        }
    }
}

Result

Campo	Tipo	Descrição
companies	CompaniesCollectionSegment	Coleção de escolas

Objeto CompaniesCollectionSegment

Campo	Tipo	Descrição
items	[Company!]	Lista de objetos do tipo `Company`
pageInfo	CollectionSegmentInfo!	Informações para auxiliar na paginação dos resultados.
totalCount	Int!	Número total de registros encontrados, independentemente da paginação.